home *** CD-ROM | disk | FTP | other *** search
/ Chip: Internet / Chip Internet.iso / viewer / sox7dos / sbprog.doc < prev    next >
Text File  |  1993-02-11  |  22KB  |  482 lines

  1. -------------------------------------------------------------------------------
  2.  
  3.                       Programming the AdLib/Sound Blaster
  4.                                 FM Music Chips
  5.                            Version 2.0 (24 Feb 1992)
  6.  
  7.                   Copyright (c) 1991, 1992 by Jeffrey S. Lee
  8.  
  9.                                jlee@smylex.uucp
  10.  
  11.  
  12.  
  13.                         Warranty and Copyright Policy
  14.  
  15.      This document is provided on an "as-is" basis, and its author makes
  16.      no warranty or representation, express or implied, with respect to
  17.      its quality performance or fitness for a particular purpose.  In no
  18.      event will the author of this document be liable for direct, indirect,
  19.      special, incidental, or consequential damages arising out of the use
  20.      or inability to use the information contained within.  Use of this
  21.      document is at your own risk.
  22.  
  23.      This file may be used and copied freely so long as the applicable
  24.      copyright notices are retained, and no modifications are made to the
  25.      text of the document.  No money shall be charged for its distribution
  26.      beyond reasonable shipping, handling and duplication costs, nor shall
  27.      proprietary changes be made to this document so that it cannot be
  28.      distributed freely.  This document may not be included in published
  29.      material or commercial packages without the written consent of its
  30.      author.
  31.  
  32.  
  33.  
  34.                                    Overview
  35.  
  36.      Two of the most popular sound cards for the IBM-PC, the AdLib and the
  37.      Sound Blaster, suffer from a real dearth of clear documentation for 
  38.      programmers.  AdLib Inc. and Creative Labs, Inc. both sell developers'
  39.      kits for their sound cards, but these are expensive, and (in the case
  40.      of the Sound Blaster developers' kit) can be extremely cryptic.
  41.  
  42.      This document is intended to provide programmers with a FREE source
  43.      of information about the programming of these sound cards.
  44.  
  45.      The information contained in this document is a combination of 
  46.      information found in the Sound Blaster Software Developer's Kit, and
  47.      that learned by painful experience.  Some of the information may not
  48.      be valid for AdLib cards; if this is so, I apologize in advance.
  49.  
  50.      Please note that numbers will be given in hexadecimal, unless otherwise
  51.      indicated.  If a number is written out longhand (sixteen instead of 16)
  52.      it is in decimal.
  53.  
  54.  |   Changes from Version 1 of the file will be indicated by the use of change
  55.  |   bars in the left-hand margin.
  56.  
  57.  
  58.  
  59.                          Chapter One - Sound Card I/O
  60.  
  61.      The sound card is programmed by sending data to its internal registers
  62.      via its two I/O ports:
  63.  
  64.              0388 (hex) - Address/Status port  (R/W)
  65.              0389 (hex) - Data port            (W/O)
  66.  
  67.  |   The Sound Blaster Pro is capable of stereo FM music, which is accessed
  68.  |   in exactly the same manner.  Ports 0220 and 0221 (hex) are the address/
  69.  |   data ports for the left speaker, and ports 0222 and 0223 (hex) are the
  70.  |   ports for the right speaker.  Ports 0388 and 0389 (hex) will cause both
  71.  |   speakers to output sound.
  72.  
  73.      The sound card possesses an array of two hundred forty-four registers;
  74.      to write to a particular register, send the register number (01-F5) to
  75.      the address port, and the desired value to the data port.
  76.  
  77.      After writing to the register port, you must wait twelve cycles before 
  78.      sending the data; after writing the data, eighty-four cycles must elapse
  79.      before any other sound card operation may be performed.
  80.  
  81.  |   The AdLib manual gives the wait times in microseconds: three point three
  82.  |   (3.3) microseconds for the address, and twenty-three (23) microseconds
  83.  |   for the data.
  84.  |
  85.  |   The most accurate method of producing the delay is to read the register
  86.  |   port six times after writing to the register port, and read the register
  87.  |   port thirty-five times after writing to the data port.
  88.  
  89.      The sound card registers are write-only.
  90.  
  91.      The address port also functions as a sound card status byte.  To 
  92.      retrieve the sound card's status, simply read port 388.  The status 
  93.      byte has the following structure:
  94.  
  95.               7      6      5      4      3      2      1      0
  96.           +------+------+------+------+------+------+------+------+
  97.           | both | tmr  | tmr  |              unused              |
  98.           | tmrs |  1   |  2   |                                  |
  99.           +------+------+------+------+------+------+------+------+
  100.  
  101.           Bit 7 - set if either timer has expired.
  102.               6 - set if timer 1 has expired.
  103.               5 - set if timer 2 has expired.
  104.  
  105.  
  106.  
  107.                        Chapter Two - The Registers
  108.  
  109. The following table shows the function of each register in the sound 
  110. card.  Registers will be explained in detail after the table.  Registers
  111. not listed are unused.
  112.  
  113.    Address      Function
  114.    -------      ----------------------------------------------------
  115.      01         Test LSI / Enable waveform control
  116.      02         Timer 1 data
  117.      03         Timer 2 data
  118.      04         Timer control flags
  119.      08         Speech synthesis mode / Keyboard split note select
  120.    20..35       Amp Mod / Vibrato / EG type / Key Scaling / Multiple
  121.    40..55       Key scaling level / Operator output level
  122.    60..75       Attack Rate / Decay Rate
  123.    80..95       Sustain Level / Release Rate
  124.    A0..A8       Frequency (low 8 bits)
  125.    B0..B8       Key On / Octave / Frequency (high 2 bits)
  126.      BD         AM depth / Vibrato depth / Rhythm control
  127.    C0..C8       Feedback strength / Connection type
  128.    E0..F5       Wave Select
  129.  
  130. The groupings of twenty-two registers (20-35, 40-55, etc.) have an odd
  131. order due to the use of two operators for each FM voice.  The following
  132. table shows the offsets within each group of registers for each operator.
  133.  
  134.  
  135.    Channel        1   2   3   4   5   6   7   8   9
  136.    Operator 1    00  01  02  08  09  0A  10  11  12
  137.    Operator 2    03  04  05  0B  0C  0D  13  14  15
  138.  
  139. Thus, the addresses of the attack/decay bytes for channel 3 are 62 for
  140. the first operator, and 65 for the second.  (The address of the second
  141. operator is always the address of the first operator plus three).
  142.  
  143. To further illustrate the relationship, the addresses needed to control
  144. channel 5 are:
  145.  
  146.     29 - Operator 1  AM/VIB/EG/KSR/Multiplier
  147.     2C - Operator 2  AM/VIB/EG/KSR/Multiplier
  148.     49 - Operator 1  KSL/Output Level
  149.     4C - Operator 2  KSL/Output Level
  150.     69 - Operator 1  Attack/Decay
  151.     6C - Operator 2  Attack/Decay
  152.     89 - Operator 1  Sustain/Release
  153.     8C - Operator 2  Sustain/Release
  154.     A4 -             Frequency (low 8 bits)
  155.     B4 -             Key On/Octave/Frequency (high 2 bits)
  156.     C4 -             Feedback/Connection Type
  157.     E9 - Operator 1  Waveform
  158.     EC - Operator 2  Waveform
  159.  
  160.  
  161.  
  162.                        Explanations of Registers
  163.  
  164. Byte 01 - This byte is normally used to test the LSI device.  All bits
  165.           should normally be zero.  Bit 5, if enabled, allows the FM 
  166.           chips to control the waveform of each operator.
  167.  
  168.              7     6     5     4     3     2     1     0
  169.           +-----+-----+-----+-----+-----+-----+-----+-----+
  170.           |   unused  | WS  |            unused           |
  171.           +-----+-----+-----+-----+-----+-----+-----+-----+
  172.  
  173.  
  174. Byte 02 - Timer 1 Data.  If Timer 1 is enabled, the value in this 
  175.           register will be incremented until it overflows.  Upon
  176.           overflow, the sound card will signal a TIMER interrupt
  177.           (INT 08) and set bits 7 and 6 in its status byte.  The
  178.           value for this timer is incremented every eighty (80)
  179.           microseconds.
  180.  
  181.  
  182. Byte 03 - Timer 2 Data.  If Timer 2 is enabled, the value in this 
  183.           register will be incremented until it overflows.  Upon
  184.           overflow, the sound card will signal a TIMER interrupt
  185.           (INT 08) and set bits 7 and 5 in its status byte.  The
  186.           value for this timer is incremented every three hundred
  187.           twenty (320) microseconds.
  188.  
  189.  
  190. Byte 04 - Timer Control Byte
  191.  
  192.         7     6     5     4     3     2     1     0
  193.      +-----+-----+-----+-----+-----+-----+-----+-----+
  194.      | IRQ | T1  | T2  |     unused      | T2  | T1  |
  195.      | RST | MSK | MSK |                 | CTL | CTL |
  196.      +-----+-----+-----+-----+-----+-----+-----+-----+
  197.  
  198.           bit 7 - Resets the flags for timers 1 & 2.  If set,
  199.                   all other bits are ignored.
  200.           bit 6 - Masks Timer 1.  If set, bit 0 is ignored.
  201.           bit 5 - Masks Timer 2.  If set, bit 1 is ignored.
  202.           bit 1 - When clear, Timer 2 does not operate.
  203.                   When set, the value from byte 03 is loaded into
  204.                   Timer 2, and incrementation begins.
  205.           bit 0 - When clear, Timer 1 does not operate.
  206.                   When set, the value from byte 02 is loaded into
  207.                   Timer 1, and incrementation begins.
  208.  
  209.  
  210. Byte 08 - CSM Mode / Keyboard Split.
  211.  
  212.         7     6     5     4     3     2     1     0
  213.      +-----+-----+-----+-----+-----+-----+-----+-----+
  214.      | CSM | Key |              unused               |
  215.      | sel | Spl |                                   |
  216.      +-----+-----+-----+-----+-----+-----+-----+-----+
  217.      
  218.           bit 7 - When set, selects composite sine-wave speech synthesis
  219.                   mode (all KEY-ON bits must be clear).  When clear,
  220.                   selects FM music mode.
  221.  
  222.           bit 6 - Selects the keyboard split point (in conjunction with
  223.                   the F-Number data).  The documentation in the Sound 
  224.                   Blaster manual is utterly incomprehensible on this;
  225.                   I can't reproduce it without violating their copyright.
  226.  
  227.  
  228. Bytes 20-35 - Amplitude Modulation / Vibrato / Envelope Generator Type /
  229.               Keyboard Scaling Rate / Modulator Frequency Multiple
  230.  
  231.         7     6     5     4     3     2     1     0
  232.      +-----+-----+-----+-----+-----+-----+-----+-----+
  233.      | Amp | Vib | EG  | KSR |  Modulator Frequency  |
  234.      | Mod |     | Typ |     |       Multiple        |
  235.      +-----+-----+-----+-----+-----+-----+-----+-----+
  236.  
  237.           bit 7 - Apply amplitude modulation when set; AM depth is
  238.                   controlled by the AM-Depth flag in address BD.
  239.           bit 6 - Apply vibrato when set;  vibrato depth is controlled
  240.                   by the Vib-Depth flag in address BD.
  241.           bit 5 - When set, the sustain level of the voice is maintained
  242.                   until released; when clear, the sound begins to decay
  243.                   immediately after hitting the SUSTAIN phase.
  244.           bit 4 - Keyboard scaling rate.  This is another incomprehensible
  245.                   bit in the Sound Blaster manual.  From experience, if 
  246.                   this bit is set, the sound's envelope is foreshortened as
  247.                   it rises in pitch.
  248.           bits 3-0 - These bits indicate which harmonic the operator will 
  249.                   produce sound (or modulation) in relation to the voice's 
  250.                   specified frequency:
  251.  
  252.                       0 - one octave below
  253.                       1 - at the voice's specified frequency
  254.                       2 - one octave above
  255.                       3 - an octave and a fifth above
  256.                       4 - two octaves above
  257.                       5 - two octaves and a major third above
  258.                       6 - two octaves and a fifth above
  259.                       7 - two octaves and a minor seventh above
  260.                       8 - three octaves above
  261.                       9 - three octaves and a major second above
  262.                       A - three octaves and a major third above
  263.                       B -  "       "     "  "   "     "     "
  264.                       C - three octaves and a fifth above
  265.                       D -   "      "     "  "   "     "
  266.                       E - three octaves and a major seventh above
  267.                       F -   "      "     "  "   "      "      "
  268.                   
  269.  
  270. Bytes 40-55 - Level Key Scaling / Total Level
  271.  
  272.         7     6     5     4     3     2     1     0
  273.      +-----+-----+-----+-----+-----+-----+-----+-----+
  274.      |  Scaling  |             Total Level           |
  275.      |   Level   | 24    12     6     3    1.5   .75 | <-- dB
  276.      +-----+-----+-----+-----+-----+-----+-----+-----+
  277.  
  278.           bits 7-6 - causes output levels to decrease as the frequency
  279.                      rises:
  280.  
  281.                           00   -  no change
  282.                           10   -  1.5 dB/8ve
  283.                           01   -  3 dB/8ve
  284.                           11   -  6 dB/8ve
  285.  
  286.           bits 5-0 - controls the total output level of the operator.
  287.                      all bits CLEAR is loudest; all bits SET is the
  288.                      softest.  Don't ask me why.
  289.  
  290.  
  291. Bytes 60-75 - Attack Rate / Decay Rate
  292.  
  293.         7     6     5     4     3     2     1     0
  294.      +-----+-----+-----+-----+-----+-----+-----+-----+
  295.      |         Attack        |          Decay        |
  296.      |          Rate         |          Rate         |
  297.      +-----+-----+-----+-----+-----+-----+-----+-----+
  298.  
  299.           bits 7-4 - Attack rate.  0 is the slowest, F is the fastest.
  300.           bits 3-0 - Decay rate.  0 is the slowest, F is the fastest.
  301.  
  302.  
  303. Bytes 80-95 - Sustain Level / Release Rate
  304.  
  305.         7     6     5     4     3     2     1     0
  306.      +-----+-----+-----+-----+-----+-----+-----+-----+
  307.      |     Sustain Level     |         Release       |
  308.      | 24    12     6     3  |          Rate         |
  309.      +-----+-----+-----+-----+-----+-----+-----+-----+
  310.  
  311.           bits 7-4 - Sustain Level.  0 is the loudest, F is the softest.
  312.           bits 3-0 - Release Rate.  0 is the slowest, F is the fastest.
  313.  
  314.  
  315. Bytes A0-B8 - Octave / F-Number / Key-On
  316.  
  317.         7     6     5     4     3     2     1     0
  318.      +-----+-----+-----+-----+-----+-----+-----+-----+
  319.      |        F-Number (least significant byte)      |  (A0-A8)
  320.      |                                               |
  321.      +-----+-----+-----+-----+-----+-----+-----+-----+
  322.  
  323.         7     6     5     4     3     2     1     0
  324.      +-----+-----+-----+-----+-----+-----+-----+-----+
  325.      |  Unused   | Key |    Octave       | F-Number  |  (B0-B8)
  326.      |           | On  |                 | most sig. |
  327.      +-----+-----+-----+-----+-----+-----+-----+-----+
  328.  
  329.           bit   5  - Channel is voiced when set, silent when clear.
  330.           bits 4-2 - Octave (0-7).  0 is lowest, 7 is highest.
  331.           bits 1-0 - Most significant bits of F-number.
  332.  
  333.      In octave 4, the F-number values for the chromatic scale and their 
  334.      corresponding frequencies would be:
  335.  
  336.         F Number     Frequency     Note
  337.            16B          277.2       C#
  338.            181          293.7       D
  339.            198          311.1       D#
  340.            1B0          329.6       E
  341.            1CA          349.2       F
  342.            1E5          370.0       F#
  343.            202          392.0       G
  344.            220          415.3       G#
  345.            241          440.0       A
  346.            263          466.2       A#
  347.            287          493.9       B
  348.            2AE          523.3       C
  349.  
  350.  
  351. Bytes C0-C8 - Feedback / Algorithm
  352.  
  353.         7     6     5     4     3     2     1     0
  354.      +-----+-----+-----+-----+-----+-----+-----+-----+
  355.      |         unused        |    Feedback     | Alg |
  356.      |                       |                 |     |
  357.      +-----+-----+-----+-----+-----+-----+-----+-----+
  358.  
  359.           bits 3-1 - Feedback strength.  If all three bits are set to
  360.                      zero, no feedback is present.  With values 1-7,
  361.                      operator 1 will send a portion of its output back
  362.                      into itself.  1 is the least amount of feedback,
  363.                      7 is the most.
  364.           bit 0    - If set to 0, operator 1 modulates operator 2.  In this
  365.                      case, operator 2 is the only one producing sound.
  366.                      If set to 1, both operators produce sound directly.
  367.                      Complex sounds are more easily created if the algorithm
  368.                      is set to 0.
  369.  
  370.  
  371. Byte BD - Amplitude Modulation Depth / Vibrato Depth / Rhythm
  372.  
  373.         7     6     5     4     3     2     1     0
  374.      +-----+-----+-----+-----+-----+-----+-----+-----+
  375.      | AM  | Vib | Rhy | BD  | SD  | TOM | Top | HH  |
  376.      | Dep | Dep | Ena |     |     |     | Cym |     |
  377.      +-----+-----+-----+-----+-----+-----+-----+-----+
  378.  
  379.           bit 7 - Set:    AM depth is 4.8dB
  380.                   Clear:  AM depth is 1 dB
  381.           bit 6 - Set:    Vibrato depth is 14 cent
  382.                   Clear:  Vibrato depth is 7 cent
  383.           bit 5 - Set:    Rhythm enabled  (6 melodic voices) 
  384.                   Clear:  Rhythm disabled (9 melodic voices)
  385.           bit 4 - Bass drum on/off
  386.           bit 3 - Snare drum on/off
  387.           bit 2 - Tom tom on/off
  388.           bit 1 - Cymbal on/off
  389.           bit 0 - Hi Hat on/off
  390.  
  391.           Note:  KEY-ON registers for channels 06, 07, and 08 must be OFF
  392.                  in order to use the rhythm section.  Other parameters
  393.                  such as attack/decay/sustain/release must also be set
  394.                  appropriately.
  395.  
  396.  
  397. Bytes E0-F5 - Waveform Select
  398.  
  399.         7     6     5     4     3     2     1     0
  400.      +-----+-----+-----+-----+-----+-----+-----+-----+
  401.      |               unused              |  Waveform |
  402.      |                                   |  Select   |
  403.      +-----+-----+-----+-----+-----+-----+-----+-----+
  404.  
  405.           bits 1-0 - When bit 5 of address 01 is set, the output waveform
  406.                      will be distorted according to the waveform indicated
  407.                      by these two bits.  I'll try to diagram them here,
  408.                      but this medium is fairly restrictive.
  409.  
  410.          ___              ___            ___    ___       _      _
  411.         /   \            /   \          /   \  /   \     / |    / |
  412.        /_____\_______   /_____\_____   /_____\/_____\   /__|___/__|___
  413.               \     /
  414.                \___/
  415.  
  416.             00              01               10               11
  417.  
  418.  
  419.  
  420.  |                          Detecting a Sound Card
  421.  |
  422.  |   According to the AdLib manual, the 'official' method of checking for a 
  423.  |   sound card is as follows:
  424.  |
  425.  |      1)  Reset both timers by writing 60h to register 4.
  426.  |      2)  Enable the interrupts by writing 80h to register 4.  NOTE: this
  427.  |          must be a separate step from number 1.
  428.  |      3)  Read the status register (port 388h).  Store the result.
  429.  |      4)  Write FFh to register 2 (Timer 1).
  430.  |      5)  Start timer 1 by writing 21h to register 4.
  431.  |      6)  Delay for at least 80 microseconds.
  432.  |      7)  Read the status register (port 388h).  Store the result.
  433.  |      8)  Reset both timers and interrupts (see steps 1 and 2).
  434.  |      9)  Test the stored results of steps 3 and 7 by ANDing them
  435.  |          with E0h.  The result of step 3 should be 00h, and the 
  436.  |          result of step 7 should be C0h.  If both are correct, an
  437.  |          AdLib-compatible board is installed in the computer.
  438.  |
  439.  |
  440.  |                              Making a Sound
  441.  | 
  442.  |   Many people have asked me, upon reading this document, what the proper
  443.  |   register values should be to make a simple sound.  Well, here they are.
  444.  | 
  445.  |   First, clear out all of the registers by setting all of them to zero.
  446.  |   This is the quick-and-dirty method of resetting the sound card, but it
  447.  |   works.  Note that if you wish to use different waveforms, you must then
  448.  |   turn on bit 5 of register 1.  (This reset need be done only once, at the
  449.  |   start of the program, and optionally when the program exits, just to 
  450.  |   make sure that your program doesn't leave any notes on when it exits.)
  451.  |
  452.  |   Now, set the following registers to the indicated value:
  453.  |
  454.  |     REGISTER     VALUE     DESCRIPTION
  455.  |        20          01      Set the modulator's multiple to 1
  456.  |        40          10      Set the modulator's level to about 40 dB
  457.  |        60          F0      Modulator attack:  quick;   decay:   long
  458.  |        80          77      Modulator sustain: medium;  release: medium
  459.  |        A0          98      Set voice frequency's LSB (it'll be a D#)
  460.  |        23          01      Set the carrier's multiple to 1
  461.  |        43          00      Set the carrier to maximum volume (about 47 dB)
  462.  |        63          F0      Carrier attack:  quick;   decay:   long
  463.  |        83          77      Carrier sustain: medium;  release: medium
  464.  |        B0          31      Turn the voice on; set the octave and freq MSB
  465.  |
  466.  |   To turn the voice off, set register B0h to 11h (or, in fact, any value 
  467.  |   which leaves bit 5 clear).  It's generally preferable, of course, to
  468.  |   induce a delay before doing so.
  469.  |
  470.  |
  471.  |                             Acknowledgements
  472.  |
  473.  |   Thanks are due to the following people:
  474.  |
  475.  |   Ezra M. Dreisbach (ed10+@andrew.cmu.edu), for providing the information
  476.  |     about the recommended port write delay from the AdLib manual, and the
  477.  |     'official' method of detecting an AdLib-compatible sound card.
  478.  |
  479.  |   Nathan Isaac Laredo (gt7080a@prism.gatech.edu), for providing the
  480.  |     port numbers for stereo sound on the Sound Blaster Pro.
  481.  
  482.